Identity

[POST] /api/v2/identity/authorization-token

创建并保存新令牌。

请求数据格式

any

返回值

状态码: 200

成功

AuthTokenResponseModel

状态码: 400

错误的请求

ServerPluginError

[DELETE] /api/v2/identity/authorization-token/{authToken}

删除指定的身份验证令牌并返回此令牌信息。

参数:

名称	类型	位置	描述
authToken必填项	string	path	将被删除的身份验证令牌。

返回值

状态码: 200

成功

AuthToken

状态码: 400

错误的请求

ServerPluginError

[GET] /api/v2/identity/authorization-token/settings

获取身份验证令牌设置。

返回值

状态码: 200

成功

TokenSettingsResponseModel

[PUT] /api/v2/identity/authorization-token/settings

保存身份验证令牌设置。

请求数据格式

TokenSettingsRequestModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

[GET] /api/v2/identity/claim-mappings

获取所有声明映射。

参数:

名称	类型	位置	描述
onlyNames	Boolean	query	是否只检索声明名称。例如：true

返回值

状态码: 200

成功

ClaimMappingModel

[POST] /api/v2/identity/claim-mappings

添加新的声明映射。

请求数据格式

ClaimMappingCreationModel

返回值

状态码: 201

已创建

ClaimMappingModel

状态码: 400

错误的请求

ApiErrorResult

[GET] /api/v2/identity/claim-mappings/{id}

获取指定的声明映射。

参数:

名称	类型	位置	描述
id必填项	string	path	声明映射 ID。

返回值

状态码: 200

成功

ClaimMappingModel

状态码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/claim-mappings/{id}

修改指定的声明映射。

参数:

名称	类型	位置	描述
id必填项	string	path	声明映射 ID。

请求数据格式

ClaimMappingCreationModel

返回值

状态码: 200

成功

ClaimMappingModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/claim-mappings/{id}

删除指定的声明映射。

参数:

名称	类型	位置	描述
id必填项	string	path	声明映射 ID。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/custom-properties

获取所有自定义属性。

返回值

状态码: 200

成功

CustomizePropertyBizModel

[POST] /api/v2/identity/custom-properties

添加新的自定义属性。

请求数据格式

CustomPropertyCreationModel

返回值

状态码: 201

已创建

CustomizePropertyBizModel

状态码: 400

错误的请求

ApiErrorResult

[GET] /api/v2/identity/custom-properties/{id}

获取指定自定义属性的信息。

参数:

名称	类型	位置	描述
id必填项	string	path	自定义属性的 id。

返回值

状态码: 200

成功

CustomizePropertyBizModel

状态码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/custom-properties/{id}

删除指定的自定义属性。

参数:

名称	类型	位置	描述
id必填项	string	path	自定义属性 ID。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/custom-properties/{id}

更新指定的自定义属性的信息。

参数:

名称	类型	位置	描述
id必填项	string	path	自定义属性 ID。

请求数据格式

CustomPropertyUpdateModel

返回值

状态码: 200

成功

CustomizePropertyBizModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/custom-properties/{id}/available-values-validation

验证指定自定义属性的新可用值。

参数:

名称	类型	位置	描述
id必填项	string	path	自定义属性 ID。

请求数据格式

CustomPropertyAvailableValuesModel

返回值

状态码: 200

成功

CustomPropertyAvailableValuesValidationModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/permissions

获取所有权限。

参数:

名称	类型	位置	描述
enabled	Boolean	query	是否只获取启用/禁用的权限。例如：true

返回值

状态码: 200

成功

PermissionModel

[GET] /api/v2/identity/security-providers

获取所有安全提供程序。

参数:

名称	类型	位置	描述
available	Boolean	query	是否只获取所有可用的安全提供程序。

返回值

状态码: 200

成功

SecurityProviderModel

[PUT] /api/v2/identity/security-providers/{name}

更新指定的安全提供程序的设置。

参数:

名称	类型	位置	描述
name必填项	string	path	安全提供程序名称。

请求数据格式

SecurityProviderModel

返回值

状态码: 200

成功

SecurityProviderModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/security-providers/{name}

删除指定的安全提供程序。

参数:

名称	类型	位置	描述
name必填项	string	path

返回值

状态码: 204

无内容

状态码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/security-providers/enable

启用或禁用指定的安全提供程序。

请求数据格式

SecurityProviderEnableModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

[POST] /api/v2/identity/security-providers/move

更新指定安全提供程序的顺序。

请求数据格式

SecurityProviderMoveModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/security-providers/reload

重新加载所有安全提供程序。

返回值

状态码: 200

成功

SecurityProviderModel

[GET] /api/v2/identity/security-providers/export

导出安全提供程序。

返回值

状态码: 200

成功

SecurityProviderModel

[POST] /api/v2/identity/security-providers/import

导入安全提供程序。

请求数据格式

SecurityProvidersImportModel

返回值

状态码: 200

成功

SecurityProviderModel

状态码: 400

错误的请求

ApiErrorResult

[GET] /api/v2/identity/sys-config

获取系统配置记录。

返回值

状态码: 200

成功

SystemConfigModel

[PUT] /api/v2/identity/sys-config

更新系统配置。

请求数据格式

SystemConfigBizModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/sys-config/name

更新公司名称。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

[PUT] /api/v2/identity/sys-config/icon

更新系统图标。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

[GET] /api/v2/identity/sys-config/icon

获取系统图标。

返回值

状态码: 200

成功

byte

[PUT] /api/v2/identity/sys-config/logo

更新登录页面中显示的图标。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

[PUT] /api/v2/identity/sys-config/bgimage

更新登录页面显示的背景图片。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

[GET] /api/v2/identity/sys-config/password-policy

获取系统密码策略。

返回值

状态码: 200

成功

PasswordPolicyInfoModel

[PUT] /api/v2/identity/sys-config/password-policy

更新系统密码策略。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

[GET] /api/v2/identity/sys-config/locked-time

锁定时间。

返回值

状态码: 200

成功

int32

[PUT] /api/v2/identity/sys-config/locked-time

更新锁定时间。

请求数据格式

int32

返回值

状态码: 204

无内容

[GET] /api/v2/identity/sys-config/show-global-organization

检索全局组织是否启用。

返回值

状态码: 200

成功

[PUT] /api/v2/identity/sys-config/css

更新自定义 CSS 内容。

返回值

状态码: 204

无内容

[PUT] /api/v2/identity/sys-config/html

更新自定义 HTML 内容。

返回值

状态码: 204

无内容

[GET] /api/v2/identity/sys-config/email-settings

获取电子邮件设置。

返回值

状态码: 200

成功

EmailSettingSMTPSettings

状态码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/sys-config/email-settings

更新电子邮件设置。

请求数据格式

EmailSettingSMTPSettings

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

[GET] /api/v2/identity/sys-config/security-settings

获取安全相关设置，包括“passwordPolicy”、“lockedTime”、“allowuserresetpassword”和“cookielifetime”。

返回值

状态码: 200

成功

SystemConfigSecuritySettings

[PUT] /api/v2/identity/sys-config/security-settings

更新安全相关设置，包括“passwordpolicy”、“lockedTime”、“allowuserresetpassword”和“cookielifetime”。

请求数据格式

SystemConfigSecuritySettings

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

[POST] /api/v2/identity/sys-config/global-organization

显示/隐藏全局组织。

请求数据格式

boolean

返回值

状态码: 204

无内容

类型定义

Ƭ AuthTokenResponseModel

表示身份验证令牌响应模型。

名称	类型	描述	示例
authToken可为空	string	获取或设置身份验证令牌。

Ƭ ServerPluginError

服务器插件错误

名称	类型	描述	示例
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	ServerPluginError

Ƭ AuthToken

名称	类型	描述	示例
authTokenKey可为空	string
token可为空	string
cookieLifetime	int32

Ƭ TokenSettingsResponseModel

获取或设置身份验证令牌设置。

名称	类型	描述	示例
lifetime可为空	int32	获取或设置令牌生命周期。

Ƭ TokenSettingsRequestModel

获取或设置身份验证令牌设置模型。

名称	类型	描述	示例
lifetime可为空	int32	获取或设置令牌生命周期。单位：秒	3600

Ƭ ClaimMappingModel

名称	类型	描述	示例
id可为空	string
name	string
propName	string
isBuiltIn	Boolean

Ƭ ApiErrorResult

该模型用于描述处理 Web 请求时发生的所有错误。

名称	类型	描述	示例
errors可为空	ApiError	错误列表。

Ƭ ApiError

该模型用于描述处理 Web 请求时发生的错误。

名称	类型	描述	示例
code可为空	string	错误的唯一标识。
message可为空	string	错误的描述文本。
context可为空	string	错误的一些相关上下文信息。

Ƭ ClaimMappingCreationModel

名称	类型	描述	示例
name	string	索赔名称。	"gender"
propName	string	自定义属性名称。	"Gender"

Ƭ CustomizePropertyBizModel

名称	类型	描述	示例
id可为空	string
name可为空	string
showInList可为空	Boolean
allowUserEdit可为空	Boolean
multivalued可为空	Boolean
showInProfile可为空	Boolean
availableValues可为空	Array<string>
valueType	PropertyValueType
sensitive可为空	Boolean

Ƭ PropertyValueType

Enum:

• Text
• Boolean
• Integer
• Float
• Date
• DateTime

组织属性的值类型。

* text - 0 - 普通字符串。
* boolean - 1 - 布尔值。
* integer - 2 - 整数。
* float - 3 - 浮点数。
* date - 4 - 日期
* datetime - 5 - 日期时间

Ƭ CustomPropertyCreationModel

名称	类型	描述	示例
name	string	自定义属性名称。	"Gender"
showInList可为空	Boolean	是否在用户列表中显示自定义属性。	true
allowUserEdit可为空	Boolean	是否允许用户编辑此自定义属性。	true
multivalued可为空	Boolean	此自定义属性是否是多值属性。
showInProfile可为空	Boolean	是否在用户个人资料页面中显示此自定义属性。	true
availableValues可为空	Array<string>	此自定义属性的可用值。	["male","female"]
valueType	PropertyValueType
sensitive可为空	Boolean	自定义属性是否敏感。

Ƭ CustomPropertyUpdateModel

名称	类型	描述	示例
name	string	自定义属性名称。	"Gender"
showInList可为空	Boolean	是否在用户列表中显示自定义属性。	true
allowUserEdit可为空	Boolean	是否允许用户编辑此自定义属性。	true
multivalued可为空	Boolean	此自定义属性是否是多值属性。
showInProfile可为空	Boolean	是否在用户个人资料页面中显示此自定义属性。	true
availableValues可为空	Array<string>	此自定义属性的可用值。	["male","female"]
valueType	PropertyValueType
sensitive可为空	Boolean	自定义属性是否敏感。

Ƭ CustomPropertyAvailableValuesValidationModel

名称	类型	描述	示例
hasInvalidValues	Boolean	是否存在一些无效值。
invalidValues可为空	Array<string>	无效值列表。

Ƭ CustomPropertyAvailableValuesModel

名称	类型	描述	示例
availableValues	Array<string>	自定义属性的可用值。	["male","female"]

Ƭ PermissionModel

名称	类型	描述	示例
name可为空	string
description可为空	string
enabled	Boolean
order	int32
module可为空	string
category可为空	string
isCustomPermission	Boolean

Ƭ SecurityProviderModel

名称	类型	描述	示例
providerName可为空	string	安全提供程序的名称。	"AD Security Provider"
description可为空	string	安全提供者的描述文本。	"The built-in AD security provider."
ordinal	int32	安全提供者的序号。	1
enabled	Boolean	是否启用安全提供程序。	true
settings可为空	ConfigurationItem	配置项。

Ƭ ConfigurationItem

名称	类型	描述	示例
name可为空	string
displayName可为空	string
description可为空	string
valueType	ConfigurationItemValueType
value可为空	any
restriction	ConfigurationItemRestriction

Ƭ ConfigurationItemValueType

Enum:

• Text
• Boolean
• Number
• Password

配置项的值类型。

* text - 0 - 普通字符串。
* boolean - 1 - 布尔值。
* number - 2 - 数字。
* password - 3 - 用作密码的字符串。

Ƭ ConfigurationItemRestriction

Enum:

• Mandatory
• Optional

配置项的限制。

* mdatory - 0 - 表示该配置项是必需的。
* optional - 1 - 表示该配置项是可选的。

Ƭ SecurityProviderEnableModel

名称	类型	描述	示例
providerNames	Array<string>	提供者名称。	["AD Security Provider","LDAP Security Provider"]
enable	Boolean	true 表示启用， false 表示禁用。	true

Ƭ SecurityProviderMoveModel

名称	类型	描述	示例
providerName	string	安全提供程序的名称。	"AD Security Provider"
offset	int32	相对于安全提供程序当前顺序的偏移量， 负数表示向上移动，正数表示向下移动。	-1

Ƭ SecurityProvidersImportModel

名称	类型	描述	示例
securityProviders	SecurityProviderModel	安全提供程序列表。

Ƭ SystemConfigModel

名称	类型	描述	示例
securitySettings	SystemConfigSecuritySettings
customView	SystemConfigCustomView
viewDecorations	SystemConfigViewDecorations
preferences	SystemConfigPreferences

Ƭ SystemConfigSecuritySettings

名称	类型	描述	示例
passwordPolicy	PasswordPolicy
lockedTime	int32	锁定时间，以分钟为单位。	60
allowUserResetPassword	Boolean	是否允许用户重置密码。
defaultCookieLifetime可为空	int32	登录时未勾选“记住我”选项的用户的 cookie 过期时间（以天为单位）。
cookieLifetimeForRememberLogin可为空	int32	登录时选中“记住我”选项的用户的 cookie 过期时间（以天为单位）。	14

Ƭ SystemConfigCustomView

名称	类型	描述	示例
loginPageTip可为空	string
css可为空	string
html可为空	string

Ƭ SystemConfigViewDecorations

名称	类型	描述	示例
logo可为空	string
bgImage可为空	string

Ƭ SystemConfigPreferences

名称	类型	描述	示例
companyName可为空	string
sysIcon可为空	string
showGlobalTenant	Boolean

Ƭ PasswordPolicy

Enum:

• WeakPasswordPolicy
• NormalPasswordPolicy
• StrongPasswordPolicy

密码策略。

* weakpasswordpolicy - 0 - 弱密码策略。
* normalpasswordpolicy - 10 - 普通密码策略。
* strongpasswordpolicy - 20 - 强密码策略。

Ƭ SystemConfigBizModel

名称	类型	描述	示例
companyName可为空	string	系统标题。	"Wyn Enterprise"
sysIcon可为空	string	系统图标的base64字符串。	"data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."
logo可为空	string	登录页面图标的 Base64 字符串。	"data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."
bgImage可为空	string	登录页面背景图片的base64字符串。	"data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."
passwordPolicy	PasswordPolicy
lockedTime可为空	int32	多次无效登录的锁定时间，单位为分钟。	60
loginPageTip可为空	string	登录页面中的提示信息。	"This is just a tip."
css可为空	string	自定义 CSS 内容。	"body { font-family: sans-serif; }"
html可为空	string	自定义 HTML 内容。	"Custom HTML Content"
allowUserResetPassword可为空	Boolean	是否允许用户重置密码。	true
showGlobalTenant可为空	Boolean	登录时是否显示“全局”组织。	true
defaultCookieLifetime可为空	int32	登录时未勾选“记住我”选项的用户的 cookie 过期时间（以天为单位）。
cookieLifetimeForRememberLogin可为空	int32	登录时选中“记住我”选项的用户的 cookie 过期时间（以天为单位）。	14

Ƭ PasswordPolicyInfoModel

名称	类型	描述	示例
name可为空	string	密码策略的名称。
value	int32	密码策略的代表值。

Ƭ EmailSettingSMTPSettings

名称	类型	描述	示例
serverAddress可为空	string	SMTP 服务器地址。	"smtp.gmail.com"
serverPort	int32	SMTP服务的监听端口。	465
enableSSL	Boolean	是否启用SSL协议。	true
userName可为空	string	登录SMTP服务的用户名。	"example@gmail.com"
password可为空	string	用户的密码。	"MyPassword"
senderName可为空	string	电子邮件发件人的显示名称。	"MyDisplayName"
senderEmail可为空	string	电子邮件发件人的显示电子邮件地址。	"example@gmail.com"
emailSenderType	EmailSenderType
googleClientId可为空	string	Google 邮件服务的客户端 ID。	"your_client_id"
googleClientSecret可为空	string	Google 邮件服务的客户端密钥。	"your_client_secret"
googleTokens可为空	string	使用 Google 邮件服务发送电子邮件生成的令牌。	"generated_token"

Ƭ EmailSenderType

Enum:

• SMTP
• GoogleAPI

电子邮件发件人类型。

* smtp - 0 - 使用 SMTP 协议发送电子邮件。
* googleapi - 1 - 使用 Google API 发送电子邮件。